Semantic Events and Scripting

Inside Macintosh: OpenDoc Class Reference / Part 2 - Types and Constants

Semantic Events and Scripting
This section describes the types and constants used in handling semantic events and scripting.

Application Shell
The following constant can be used in place of a destination part to send an Apple event to the application shell.

kODAppShell
A pointer of type ODPart* that can be used to represent the application shell as a parameter to methods related to semantic events.

Apple Events
The following types are used for working with Apple events.

ODDescType
A wrapper for the Apple events type DescType; an Apple events descriptor type. The section "Descriptor Types" on page 926 describes the constants defined for this type.
ODEventClass
A wrapper for the Apple events type AEEventClass, the event class of an Apple event.
ODEventID
A wrapper for the Apple events type AEEventID, the ID of an Apple event.
ODSendMode
A wrapper for the Apple events type AESendMode, a context-specific mode associated with an Apple event.
ODSendPriority
A wrapper for the Apple events type AESendPriority, a priority specifying whether an Apple event is put at the back of the event queue or at the front of the queue.

Descriptor Types
This section describes the constants defined for the ODDescType type (page 925). You should use these constants only when writing an 'aete' resource that overrides some of the standard scripting support provided by OpenDoc.

General Descriptor Types
The following descriptor types are used for a variety of purposes.

kAEOpenDocSuite
The type code for the OpenDoc suite in the 'aete' resource (value 'odst'). You must use this suite code in your 'aete' resource if you wish to inherit the OpenDoc suite from the system's 'aeut' resources.
kODStandardPartTokenType
The type code for the standard part token, as returned from the name resolver's Resolve method (page 426); this type code is reserved and parts should never use it. This constant is equivalent to the cPart constant.

OpenDoc-Suite Classes
The following descriptor types correspond to the Apple events object model properties representing general elements (classes) of the OpenDoc suite.

cDraft
A draft (value 'drft').
cPart
A part (value 'part').
cIconFamily
An icon family (value 'ifam').

Part-Information Properties
The following descriptor types correspond to the Apple events object model properties representing the properties shown in the Part Info dialog window.

pASCreationDate
The part's creation date (value 'ascd').
pASModificationDate
The part's modification date (value 'asmo').
pAuthor
The part's author (value 'auth').
pBundled
Specifies whether the part is bundled (value 'bndl').
pCategory
The part's category (value 'pcat').
pComment
A comment about the part (value 'comt').
pContainer
The part that contains this part (value 'ctnr').
pEditor
The part's editor (value 'edtr').
pEditorName
The part's name (value 'enam').
pIcon
The part's icon (value 'iimg').
pKind
The part kind of the part (value 'kind').
pShowLinks
Specifies that all part editors should display all link borders in all windows displaying the document (value 'slnk').
pSize
The part's size (value 'size').
pStationery
Specifies that the part is a stationery part (value 'stat').
pUniqueID
The ID number for the part (value 'ID ').
pViewType
The part's view type (value 'vwty').
enumViewType
The part's view type (value 'vwty'). This constant is equivalent to the pViewType constant. The section "View Types" on page 928 describes the descriptor types representing possible view types.

View Types
The following descriptor types represent possible view types for a part, as shown in the Part Info dialog window.

kAEODFrame
Frame.
kAEODLargeIcon
Large icon (standard icon).
kAEODSmallIcon
Small icon.
kAEODThumbnail
Thumbnail icon.